[notification-hubs] fix TypeError when parsing AppleTemplateRegistrationDescription #36114
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ionDescription Currently `getHeadersOrUndefined` incorrectly assumes that the `ApnsHeaders` parsed from XML is always an array. However, for single XML element the XML parser gives back an object instead. This change ensures we are iterating over an array.
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a TypeError in the notification-hubs SDK when parsing AppleTemplateRegistrationDescription with a single APNS header. The XML parser returns an object for single elements instead of an array, causing iteration errors.
- Fixed the
getHeadersOrUndefinedfunction to handle both array and single object cases - Added test coverage for the single APNS header scenario
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
src/serializers/registrationSerializer.ts |
Updated function signature and logic to handle both array and object types for APNS headers |
test/internal/unit/registrationSerializer.spec.ts |
Added test constant and test case for single APNS header scenario |
sdk/notificationhubs/notification-hubs/test/internal/unit/registrationSerializer.spec.ts
Show resolved
Hide resolved
6 tasks
deyaaeldeen
approved these changes
Oct 6, 2025
|
/check-enforcer override |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently
getHeadersOrUndefinedincorrectly assumes that theApnsHeadersparsed from XML is always an array. However, for single XML element the XML parser gives back an object instead. This change ensures we are iterating over an array.One alternative approach is to add an option to
core-xmlspecifying whether to treat certain single xml elements as an object or the single item of an array. Our underlying XML parserfast-xml-parserallows passing in aisArray: (name, jpath, isLeafNode, isAttribute) => booleanpredicate but it is specific tofast-xml-parserand needs more discussion on how to properly expose it incore-xml. For this targeted scenario, it is good enough to check whether the parsed result is an array. This package uses same pattern in other places too, for example, https://github.com/Azure/azure-sdk-for-js/blob/953fcf9f84b/sdk/notificationhubs/notification-hubs/src/serializers/notificationHubJobSerializer.ts#L61